<!doctype html>
<html>
<head>
    <meta charset='UTF-8'>
    <meta name='viewport' content='width=device-width initial-scale=1'>
    <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" />
    <meta http-equiv="Pragma" content="no-cache" />
    <meta http-equiv="Expires" content="0" />
    <link rel="stylesheet" href="markdown.css?v=1641871594082"/>
    <title>额外参数接口</title>
</head>
<body>
<div class="markdown-body">
    <h1>额外参数接口</h1>
<h2>根据项目获取参数列表</h2>
<p><strong>URL:</strong> <code>http://your_ip:port/api/param/getList</code></p>
<p><strong>Type:</strong> <code>ANY</code></p>
<p><strong>Content-Type:</strong> <code>application/x-www-form-urlencoded;charset=utf-8</code></p>
<p><strong>Description:</strong> 根据项目获取参数列表</p>
<p><strong>Request-parameters:</strong></p>
<table>
<thead>
<tr><th>Parameter</th><th>Type</th><th>Description</th><th>Required</th><th>Since</th></tr>
</thead>
<tbody>
<tr><td>serverId</td><td>string</td><td>所属反向代理id</td><td>true</td><td>-</td></tr>
<tr><td>locationId</td><td>string</td><td>所属代理目标id</td><td>true</td><td>-</td></tr>
<tr><td>upstreamId</td><td>string</td><td>所属负载均衡id</td><td>true</td><td>-</td></tr>
</tbody>
</table>
<p><strong>Request-example:</strong></p>
<pre><code>curl   -i http://your_ip:port/api/param/getList?upstreamId=45&amp;locationId=45&amp;serverId=45
</code></pre>
<p><strong>Response-fields:</strong></p>
<table>
<thead>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Since</th></tr>
</thead>
<tbody>
<tr><td>success</td><td>boolean</td><td>请求结果</td><td>-</td></tr>
<tr><td>status</td><td>string</td><td>请求状态 200:请求成功 401:token无效 500:服务器错误</td><td>-</td></tr>
<tr><td>msg</td><td>string</td><td>错误信息</td><td>-</td></tr>
<tr><td>obj</td><td>object</td><td>返回内容</td><td>-</td></tr>
<tr><td>└─id</td><td>string</td><td>主键</td><td>-</td></tr>
<tr><td>└─serverId</td><td>string</td><td>所属反向代理id</td><td>-</td></tr>
<tr><td>└─locationId</td><td>string</td><td>所属代理目标id</td><td>-</td></tr>
<tr><td>└─upstreamId</td><td>string</td><td>所属负载均衡id</td><td>-</td></tr>
<tr><td>└─name</td><td>string</td><td>参数名</td><td>-</td></tr>
<tr><td>└─value</td><td>string</td><td>参数值</td><td>-</td></tr>
</tbody>
</table>
<p><strong>Response-example:</strong></p>
<pre><code>{
	&quot;success&quot;:true,
	&quot;status&quot;:&quot;454i6z&quot;,
	&quot;msg&quot;:&quot;jmej9l&quot;,
	&quot;obj&quot;:[
		{
			&quot;id&quot;:&quot;45&quot;,
			&quot;serverId&quot;:&quot;45&quot;,
			&quot;locationId&quot;:&quot;45&quot;,
			&quot;upstreamId&quot;:&quot;45&quot;,
			&quot;name&quot;:&quot;鹤轩.白&quot;,
			&quot;value&quot;:&quot;jbxs19&quot;
		}
	]
}
</code></pre>
<h2>添加或编辑参数</h2>
<p><strong>URL:</strong> <code>http://your_ip:port/api/param/insertOrUpdate</code></p>
<p><strong>Type:</strong> <code>ANY</code></p>
<p><strong>Content-Type:</strong> <code>application/x-www-form-urlencoded;charset=utf-8</code></p>
<p><strong>Description:</strong> 添加或编辑参数</p>
<p><strong>Request-parameters:</strong></p>
<table>
<thead>
<tr><th>Parameter</th><th>Type</th><th>Description</th><th>Required</th><th>Since</th></tr>
</thead>
<tbody>
<tr><td>id</td><td>string</td><td>主键</td><td>false</td><td>-</td></tr>
<tr><td>serverId</td><td>string</td><td>所属反向代理id</td><td>false</td><td>-</td></tr>
<tr><td>locationId</td><td>string</td><td>所属代理目标id</td><td>false</td><td>-</td></tr>
<tr><td>upstreamId</td><td>string</td><td>所属负载均衡id</td><td>false</td><td>-</td></tr>
<tr><td>name</td><td>string</td><td>参数名</td><td>false</td><td>-</td></tr>
<tr><td>value</td><td>string</td><td>参数值</td><td>false</td><td>-</td></tr>
</tbody>
</table>
<p><strong>Request-example:</strong></p>
<pre><code>curl   -i http://your_ip:port/api/param/insertOrUpdate?updateTime=1641871596310&amp;templateId=45&amp;locationId=45&amp;templateValue=n34iov&amp;id=45&amp;templateName=鹤轩.白&amp;createTime=1641871596310&amp;serverId=45&amp;upstreamId=45&amp;value=ch4j2p&amp;name=鹤轩.白
</code></pre>
<p><strong>Response-fields:</strong></p>
<table>
<thead>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Since</th></tr>
</thead>
<tbody>
<tr><td>success</td><td>boolean</td><td>请求结果</td><td>-</td></tr>
<tr><td>status</td><td>string</td><td>请求状态 200:请求成功 401:token无效 500:服务器错误</td><td>-</td></tr>
<tr><td>msg</td><td>string</td><td>错误信息</td><td>-</td></tr>
<tr><td>obj</td><td>object</td><td>返回内容</td><td>-</td></tr>
</tbody>
</table>
<p><strong>Response-example:</strong></p>
<pre><code>{
	&quot;success&quot;:true,
	&quot;status&quot;:&quot;7mz8tn&quot;,
	&quot;msg&quot;:&quot;m8xwge&quot;,
	&quot;obj&quot;:{
		
	}
}
</code></pre>
<h2>删除额外参数</h2>
<p><strong>URL:</strong> <code>http://your_ip:port/api/param/del</code></p>
<p><strong>Type:</strong> <code>ANY</code></p>
<p><strong>Content-Type:</strong> <code>application/x-www-form-urlencoded;charset=utf-8</code></p>
<p><strong>Description:</strong> 删除额外参数</p>
<p><strong>Request-parameters:</strong></p>
<table>
<thead>
<tr><th>Parameter</th><th>Type</th><th>Description</th><th>Required</th><th>Since</th></tr>
</thead>
<tbody>
<tr><td>id</td><td>string</td><td>参数id</td><td>true</td><td>-</td></tr>
</tbody>
</table>
<p><strong>Request-example:</strong></p>
<pre><code>curl   -i http://your_ip:port/api/param/del?id=45
</code></pre>
<p><strong>Response-fields:</strong></p>
<table>
<thead>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Since</th></tr>
</thead>
<tbody>
<tr><td>success</td><td>boolean</td><td>请求结果</td><td>-</td></tr>
<tr><td>status</td><td>string</td><td>请求状态 200:请求成功 401:token无效 500:服务器错误</td><td>-</td></tr>
<tr><td>msg</td><td>string</td><td>错误信息</td><td>-</td></tr>
<tr><td>obj</td><td>object</td><td>返回内容</td><td>-</td></tr>
</tbody>
</table>
<p><strong>Response-example:</strong></p>
<pre><code>{
	&quot;success&quot;:true,
	&quot;status&quot;:&quot;20eaza&quot;,
	&quot;msg&quot;:&quot;zmwywh&quot;,
	&quot;obj&quot;:{
		
	}
}
</code></pre>

    <footer class="page-footer">
        <span class="copyright">Generated by smart-doc at 2022-01-11 11:26:34</span>
        <span class="footer-modification">Suggestions, contact, support and error reporting on
            <a href="https://gitee.com/smart-doc-team/smart-doc" target="_blank">Gitee</a> or
            <a href="https://github.com/smart-doc-group/smart-doc" target="_blank">Github</a>
        </span>
    </footer>
</div>
</body>
</html>